qaCtlGetClientId.h

Go to the documentation of this file.

/*
 * \ingroup ctl
 *
 * \file qaCtlGetClientId.h
 *
 * \brief This file contains definitions, enumerations, structures and
 *        forward declarations for qaCtlGetClientId.c
 *
 * Copyright: © 2019 Sierra Wireless, Inc. all rights reserved
 *
 */

#ifndef __CTL_GET_CLIENT_ID_MSG_H__
#define __CTL_GET_CLIENT_ID_MSG_H__



/* enum declarations */
/*
 * An enumeration of eQMI_CTL_GET_CLIENT_ID request TLV IDs
 *
 */
enum eCTL_GET_CLIENT_ID_REQ
{
    eTLV_QMI_SERVICE_TYPE = 0x01
};

enum CTL_GET_CLIENT_ID_RESP
{
    eTLV_ASSIGNED_CLIENT_ID = 0x01
};

/*
 * This structure contains the GetClientId request parameters.
 *
 * \sa qaGobiApiCtl.h for parameter descriptions
 *
 */
struct QmiCtlGetClientIdReq
{
    BYTE serviceType;
};

/*
 * This structure contains the GetClientId response parameters.
 *
 */
struct QmiCtlGetClientIdResp
{
    /* Every response message must have a results structure */
    struct qmTlvResult results;

    BYTE* pServiceType;
    BYTE* pClientId;
};

/*
 * Prototypes
 *
 */
extern enum eQCWWANError PkQmiCtlGetClientId(
    WORD  *pMlength,
    BYTE  *pBuffer,
    BYTE serviceType );

extern enum eQCWWANError UpkQmiCtlGetClientId(
    BYTE *pMdmResp,
    struct QmiCtlGetClientIdResp *pApiResp );

#endif /* __CTL_GET_CLIENT_ID_MSG_H__ */